You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
ci: publish package previews of pull requests on TanStack Source - #2128
The pr workflow on TanStack Source gets a preview job. It builds the packages and runs the new built-in step packagePreview({ npm: ['packages/*'] }). The step uploads one tarball for each package into the repository's assets under package-previews/<pr>/<short sha>/, and the forge keeps one comment with an npm i <url> line for each package. It does the same job as the Preview job of pr.yml with pkg.pr.new.
Testing
The preview check of this pull request fails at Set up Node, as expected. A job that is new in a pull request runs with no secrets, variables, permissions or egress until the change is merged, so it cannot reach nodejs.org. The run shows this as a warning.
After this merges, the next pull request publishes its previews. The forge deletes them 3 to 4 days after that pull request closes.
Manual test, after the merge:
Open a pull request from a branch of this repository.
Wait for the preview check. The forge writes a comment with the install lines.
Run one npm i <url> line in an empty folder. The package installs.
Risk / rollback
Each pull request run builds every package once more, in its own job, next to test.
The previews count toward the 10 GiB of assets of the repository.
Rollback: revert this pull request. The GitHub Preview job with pkg.pr.new did not change.
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
No actionable comments were generated in the recent review.
Walkthrough
The pull request workflow clarifies that the Test check runs on TanStack Source while the Coverage job remains on GitHub. It adds a preview job that builds packages and calls packagePreview for packages/*.
Changes: Pull request workflow
Layer / File(s)
Summary
Test job definition .source/workflows/pr.ts
The comments distinguish the Test check from the Coverage job. The existing test configuration is expressed as a chained job call, with its settings and command unchanged.
Package preview job .source/workflows/pr.ts
A new job installs dependencies, builds all packages, and calls packagePreview for packages/*. It uses the browser image and egress allowlist, disables Nx Cloud, and grants packages: 'preview' permission.
TanStack/ai#2075: Adds the TanStack Source PR workflow and its test job, which this change extends with a preview job.
TanStack/ai#1980: Updates the GitHub PR Preview job that publishes packages; this change adds a separate Source preview job and leaves the GitHub job unchanged.
Merge Risk: Minimal · up to 74726
Merge Risk:⚪ Minimal · up to 74726
The change adds package previews; no actionable merge-blocking issue was established.
Pre-merge checks: 5
Check name
Status
Explanation
Title check
The title clearly summarizes the main change: publishing package previews for pull requests through TanStack Source.
Docstring Coverage
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Description check
The description clearly explains the workflow change, testing, risks, and rollback. It does not include the template’s checklist or an explicit release-impact statement, but the description is otherwi…
Full details: Docstring Coverage
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 1 files.
Full details: Description check
Explanation
The description clearly explains the workflow change, testing, risks, and rollback. It does not include the template’s checklist or an explicit release-impact statement, but the description is otherwise complete.
Finishing Touches
Generate docstrings
Commit to this branch
Create a new PR
Generate unit tests (beta)
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Reviewing files that changed from the base of the PR and between cbf6281 and 4542ad6.
Files selected for processing: 1
.source/workflows/pr.ts
Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
prworkflow on TanStack Source gets apreviewjob. It builds the packages and runs the new built-in steppackagePreview({ npm: ['packages/*'] }). The step uploads one tarball for each package into the repository's assets underpackage-previews/<pr>/<short sha>/, and the forge keeps one comment with annpm i <url>line for each package. It does the same job as thePreviewjob ofpr.ymlwith pkg.pr.new.Testing
previewcheck of this pull request fails atSet up Node, as expected. A job that is new in a pull request runs with no secrets, variables, permissions or egress until the change is merged, so it cannot reach nodejs.org. The run shows this as a warning.Manual test, after the merge:
previewcheck. The forge writes a comment with the install lines.npm i <url>line in an empty folder. The package installs.Risk / rollback
test.Previewjob with pkg.pr.new did not change.